home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 46 / Amiga Format CD46 (1999-10-20)(Future Publishing)(GB)[!][issue 1999-12].iso / -in_the_mag- / reader_requests / scilab / readme < prev    next >
Text File  |  1999-09-16  |  15KB  |  355 lines
  1.               Scilab version 2.2
  2.                           ******************
  3.                29 February 1996
  4.  
  5. ******************************************************************************
  6.                   INSTALLATION GUIDE
  7. ******************************************************************************
  8.  
  9. 0 - COPYRIGHT NOTICE
  10. ********************
  11.  
  12. To use Scilab, you need to fill and return the end of the file notice.tex 
  13. or notice.ps (postscript file). You may use email.
  14.  
  15. ******************************************************************************
  16.  
  17. In the following, all the paths are relative to the Scilab directory 
  18. (scilab-2.2 directory).
  19.  
  20. I - TO INSTALL SCILAB
  21. *********************
  22.  
  23.  A - IF YOU HAVE A COMPILED VERSION
  24.  ----------------------------------
  25.    Simply do, in Scilab directory:
  26.     make
  27.   
  28.  B - IF YOU HAVE A SOURCE VERSION
  29.  --------------------------------
  30.    This distribution has been tested on the following machines:
  31.    HP9000, SUN Sparcstation (Sun OS and Solaris 5.*), IBM RS6000, DEC mips, 
  32.    DEC alpha, SGI (IRIX 5.2) and PC linux (a.out and ELF).
  33.  
  34.    You need X Window (X11R4, X11R5 or X11R6), Athena Widgets libraries, 
  35.    C compiler and fortran compiler.
  36.  
  37.    1 - Configure your system by issuing the following command in the Scilab 
  38.        directory:
  39.     ./configure
  40.  
  41.        This will create modify a few Makefile and other files for your system.
  42.        You can give options to configure command, see below.
  43.  
  44.    2 - Do in the Scilab directory:
  45.     make all
  46.  
  47.        This will compile Scilab and set everything.
  48.  
  49.    Configure options:
  50.    ------------------
  51.     -enable-debug: compile with "-g" option and don't optimize
  52.  
  53.     -with-gcc: use gcc C compiler (note that the compilation options
  54.           have not been tested on all machines, see C below)
  55.  
  56.     -with-g77: use g77 fortran compiler (note that the compilations
  57.           options have not been tested on all machines, see C below)
  58.  
  59.     -with-gnu: use gcc C compiler and g77 fortran compiler (note that 
  60.           the compilation options have not been tested on all machines, 
  61.           see C below)
  62.  
  63.     -with-local-Xaw: compile and use Athena Widgets libraries given 
  64.           with Scilab (don't use then for X11R4); configure chooses local
  65.           Athena Widgets library when needed, so the use of this option is not
  66.           recommanded (see below KNOWN PROBLEMS 3).
  67.  
  68.  C _ CHANGING THE COMPILATION OPTIONS (source version only)
  69.  ------------------------------------
  70.     You may want to change the options used to compile Scilab, names of the
  71.     compilers, compilation options, linker options, and so on; you can easily 
  72.     do that.
  73.  
  74.     The main Makefile of Scilab includes "Makefile.incl" and 
  75.     "Makefile.<machine>":
  76.       "Makefile.incl" contains all the compilation options
  77.       "Makefile.<machine>" is only used for the link of the executable 
  78.           "scilex" of Scilab
  79.  
  80.    The file "Makefile.incl" is included by all the Makefiles of the 
  81.    distribution, so it is THE place where you can change compilation 
  82.    options (it is self documented).
  83.  
  84.    Note that "Makefile.incl" is automatically generated by "configure"
  85.    from "Makefile.incl.in", so your modifications of "Makefile.incl" are
  86.    discarded every time you run "configure". 
  87.    Users knowing the way "configure" works may want to modify directly the 
  88.    "configure" file.
  89.    Even more, users knowing the way "autoconf" works may want to modify 
  90.    the "configure.in" file and then run "autoconf" (version 2.7) to generate
  91.    the "configure" file.
  92.  
  93.  D - CUSTOMIZING YOUR SCILAB
  94.  ---------------------------
  95.    1 - If you want to recompile Scilab after modifications, execute only 
  96.        the "make all" command in Scilab directory (source version only).
  97.  
  98.        If you want to clean all executable, object files and libraries 
  99.        and then recompile Scilab, execute the following commands
  100.        (source version only):
  101.     make distclean
  102.     make all
  103.  
  104.    2 - To print your postscript figures you may need to modify 
  105.        the function "macros/xdess/xbasimp.sci" to specify
  106.        your default printer.
  107.  
  108.    3 - Note that the functions "macros/util/edit" and 
  109.        "macros/util/manedit" assume that your default editor 
  110.        is emacs. You may change this (or explicitly specify your
  111.        editor when you invoke these functions).
  112.  
  113.    4  - COLOR RESOURCES: if you want to change the colors of your 
  114.     customization you need to modify the files in the subdirectory 
  115.     X11_defaults (essentially the Xscilab file) or to copy the same
  116.         color resources in your personal resource file (home directory).
  117.  
  118. ******************************************************************************
  119. II - KNOWN PROBLEMS
  120. *******************
  121.    0 - Note that C routines are not ANSI.
  122.  
  123.    1 - If there is something wrong when you open the scilab window 
  124.        check your .Xdefault file.
  125.  
  126.    2 - The fortran compiler version 1.3.1 of SUN Sparcstations has a bug:
  127.        reading or writing (with implicit loop) arrays  bigger than 4096 
  128.        elements does not work. This may cause Scilab to abort.
  129.        The solution is to upgrade your fortran compiler, for instance get 
  130.        version 1.4 (or use version 1.3.1 with object file "recio.o" from 
  131.        newer version).
  132.  
  133.    3 - Athena Widgets libraries libXaw.a and libXmu.a (and corresponding 
  134.        include files) are not systematically provided in some X11 
  135.        installations. If you are under X11R5 or X11R6, these libraries are 
  136.        provided for convenience with Scilab.
  137.        "configure" tries first to find existing Athena Widgets libraries.
  138.        If none are found and X Window release is not X11R4, it uses
  139.        local Athena Widgets libraries. Otherwise an error is issued.
  140.        You can impose the use of local Athena Widgets libraries by using
  141.        the option "-with-local-Xaw" with "configure".
  142.  
  143.        On IBM RS6000 there exists a compatibility problem between the
  144.        X11-Mit distribution and the IBM version. If your system runs the IBM
  145.        X11 release you must use the IBM libXaw.a and libXmu.a libraries.
  146.  
  147.    4 - For DEC ALPHA station you must use the 3.4 version of the fortran 
  148.        compiler (the 3.3 version aborts on floating point exceptions).
  149.        You are encouraged to use the OSF 3.0 system release and the fortran
  150.        3.5 release (the incremental link works fine as well as all the
  151.        floating point exceptions).
  152.  
  153.    5 - For Dec MIPS Ultrix, programs to be incrementally linked should be 
  154.        compiled with the option "-G 0".
  155.    
  156.    6 - If you have any problem or suggestion to improve Scilab
  157.        send him an email:
  158.        
  159.                           Scilab@inria.fr
  160.  
  161. ******************************************************************************
  162. III - TO RUN SCILAB
  163. *******************
  164.  
  165. Run Scilab by executing "scilab" (shell script in bin).
  166.  
  167. If the name of the directory of Scilab distribution is not the same on 
  168. your machine than on the machine where Scilab was installed, define the
  169. environment variable SCI to point to the directory of Scilab distribution.
  170. In a sh like shell, do:
  171.  SCI=<name of the directory>
  172.  export SCI
  173. In a csh like shell, do:
  174.  setenv SCI <name of the directory>
  175.  
  176. ******************************************************************************
  177. IV - DOCUMENTATION
  178. ****************** 
  179.  
  180. In addition to Scilab online documentation (obtained by typing "help item" or
  181. "apropos keyword" or clicking on the help button), you will find 
  182. compressed postscript documentation by anonymous ftp on
  183. "ftp.inria.fr:/INRIA/Projects/Meta2/Scilab/doc" (internet# 192.93.2.54).
  184.  
  185. Internals.ps.Z
  186. Intersci.ps.Z
  187. Intro.ps.Z
  188. Lmi.ps.Z
  189. Manual.ps.Z
  190. Metanet.ps.Z
  191. Signal.ps.Z
  192.  
  193. ******************************************************************************
  194. V - CONTENT OF THE DIRECTORIES
  195. ******************************
  196.  
  197. scilab.star: startup file for Scilab: instructions in this file
  198.              are executed when Scilab is executed. Note that
  199.              you can also have your own startup file ".scilab"
  200.              in your current directory.
  201.  
  202. configure.in: used by "autoconf 2.7" to generate "configure"
  203.  
  204. configure:
  205.  
  206. Makefile.incl.in: the file used by configure to generate Makefile.incl.
  207.  
  208. Makefile.incl: the file included by all Makefile. It is automatically 
  209.                generated by configure.
  210.  
  211. Path.incl: contains the scilab directory pathname. It is included by 
  212.             scripts/Makefile. This file is automatically generated by 
  213.             configure.
  214.  
  215. Version.incl: contains the scilab version. It is included by a few Makefile.
  216.  
  217. Makefile.in: the file used by configure to generate Makefile.
  218.  
  219. Makefile: the main Makefile to make Scilab. It is automatically generated by
  220.            configure.
  221.  
  222. Makefile.<host>: Makefile included by main Makefile. It depends on the host
  223.                  and is used to created the executable bin/scilex.
  224.  
  225. config/   : directory used by configure
  226.  
  227. demos/    : demos directory. Some of the demos can be executed by clicking
  228.             on the "demos" button.
  229.  
  230. macros/   : functions directory: this directory is divided into 
  231.             subdirectories corresponding to specific topics
  232.             (control, polynomials,...). Each subdirectory contains 
  233.             the source code of the macros (files *.sci). 
  234.  
  235. xmetanet/ : Metanet routines.
  236.  
  237. geci/     : Geci (interprocess communication tool) routines.
  238.  
  239. libs/      : directory of libraries: archives of object files needed 
  240.              to link Scilab.
  241.  
  242. routines/ : directory of fortran or C routines. Divided into subdirectories
  243.              (see below).
  244.  
  245. doc/      : directory of documentation. Usually LaTeX files.
  246.  
  247. man/      : man files and LaTeX manual.
  248.  
  249. tests/    : set of exec files to test Scilab.
  250.  
  251. util/     : useful routines and ASCII files to manage Scilab.
  252.  
  253. bin/      : executable code and scripts.
  254.         scilab  : shell-script to call Scilab and miscellaneous tools
  255.                           execute scilab -help scilab for help.
  256.         scilex  : executable code of Scilab.
  257.         minfopr : shell script called by scilab -macro.
  258.         scilink : shell script called by scilab -link.
  259.                 intersci: generator of interface program between Scilab and 
  260.                           routines.
  261.  
  262. intersci/ : Generator of interface program between Scilab and routines.
  263.  
  264. maple/    : Maple code to link Maple with Scilab.
  265.  
  266. ******************************************************************************
  267. VI - TO CREATE YOUR OWN CUSTOMIZED SCILAB
  268. *****************************************
  269. ----------------------------------
  270.    USE YOUR OWN ROUTINES IN SCILAB
  271. ----------------------------------
  272.  
  273. Directory routines
  274.  
  275. stack.h    : this file is included in many fortran programs of subdirectories
  276.              of "routines".
  277.  
  278. Directory routines/default
  279.  
  280. matusr.f   : interface to add your own commands to Scilab (see the help for
  281.              "user" command).
  282. interf.f   :interface for fast call to a fortran routine (see the "fort"
  283.               command and the "link" command)
  284.  
  285. Other routines in this directory are used to interface external fortran
  286. routines for use with the functions ode (non linear simulation), optim (non
  287. linear optimization), intg (definite integrals), impl (implicit systems) and
  288. schur (schur form with ordering defined by a fortran routine).
  289.     
  290. To use your own routines you need to replace the 
  291. code .o in the directory routines/default by your own code, or use 
  292. shell command "scilab -link <object-files>" (type "scilab -help" for 
  293. help).
  294.  
  295. ******************************************************************************
  296. VII - ORIGIN OF CODE
  297. ********************
  298.  
  299.     The contribution of many people is acknowledged (the following list
  300.     is not exhaustive!).
  301.  
  302. X11G   : Scilab graphic routines by Jean-Philippe Chancelier (Cergrene Enpc).
  303. calelm : BLAS + low level routines (INRIA).
  304. control: LINPACK + EISPACK + INRIA routines.
  305.          dsubsp and exchnqz : Paul van Dooren.
  306.          rpoly : copyrighted by the ACM (alg. 493), which grants
  307.                  general permission to distribute provided 
  308.                  the copies are not made for direct commercial advantage. 
  309.          lybsc, lydsr, lybad,sydsr and sybad are adapted from SLICE 
  310.                 (M. Denham).
  311.          sszer: Emami-naeini, A. and van Dooren, P. (Automatica paper).
  312.          syhsc: G.Golub, S.Nash, C.van Loan, Stanford University.
  313.          rilac, ricd : A. Laub.
  314.          dexpm1, pade, dclmat, coef, cerr, wexpm1, wpade, wclmat: J. Roche.
  315.          polmc: adapted from P.Hr. Petkov, Sofia, Bulgaria.
  316.          bdiag: adapted from Bavely and Stewart.
  317.          ereduc,fstair: T. Beelen, P. Van Dooren.
  318. default: Scilab routines (INRIA) for the user.
  319. dld     :  is a library package of C functions that performs "dynamic link
  320.         editing" from  Wilson Ho (how@cs.ucdavis.edu). It is used on 
  321.         the linux version of scilab.
  322. dynamic: Scilab routines for dynamic interfacing (INRIA).
  323. integ  : routines from Odepack and Quadpack.
  324.          dassl: L. Petzold (LLNL).
  325.          hybrd: Minpack (ANL).
  326. interf : Scilab interface with numerical libraries (INRIA).
  327. metanet: routines for network analysis (Metanet, INRIA).
  328. optim  : optimization routines (Modulopt library, INRIA).
  329.          quapro: E. Casas Renteria & C. Pola Mendez (Universidad de Cantabria).
  330.          semidef: L. Vandenberghe- S. Boyd code (sp.c, see copyright notice in
  331.          /routines/optim).
  332. poly   : Scilab polynomial library (INRIA).
  333. signal : routines from IEEE Signal processing library.
  334. sparse : Sparse 1.3 by Kenneth S. Kundert, Alberto Sangiovanni-Vincentelli and 
  335.         the University of California (see Copyright notice in programs of 
  336.         the "sparse" directory). Some operations are taken from
  337.         TOMS 408 and 601.
  338. sun    : system specific Scilab routines. 
  339.          link.c is originated from a program written by Michael Fan and 
  340.          provided by Andre Tits (University of Maryland).
  341.          zzledt.c is from Mitchell and Gauthier ass.
  342. system : basic routines of Scilab interpreter (INRIA). Inspired by
  343.         "classic" Matlab of C. Moler.
  344. system2: low level Scilab routines (INRIA).
  345. X11    : optionnal Xaw and Xmu routines  (from mit X11 distribution)
  346. xless  : Xless
  347. xsci   : top level window and utilities using code from : xterm, xxgdb, xfig 
  348.      combined and modified by JPChancelier.
  349. xwindow: Scilab menus (INRIA).
  350. geci   : interprocess communication tool made by CalICo group from
  351.          LaBRI (University of Bordeaux I, France).
  352. ******************************************************************************
  353.                    THAT'S ALL FOLKS
  354. ******************************************************************************
  355.